home *** CD-ROM | disk | FTP | other *** search
/ X User Tools / X User Tools (O'Reilly and Associates)(1994).ISO / sun4c / archive / tcltk.z / tcltk / man / mann / wm.n < prev   
Text File  |  1994-09-20  |  31KB  |  717 lines
  1. '\"
  2. '\" Copyright (c) 1991 The Regents of the University of California.
  3. '\" All rights reserved.
  4. '\"
  5. '\" Permission is hereby granted, without written agreement and without
  6. '\" license or royalty fees, to use, copy, modify, and distribute this
  7. '\" documentation for any purpose, provided that the above copyright
  8. '\" notice and the following two paragraphs appear in all copies.
  9. '\"
  10. '\" IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
  11. '\" FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
  12. '\" ARISING OUT OF THE USE OF THIS DOCUMENTATION, EVEN IF THE UNIVERSITY OF
  13. '\" CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  14. '\"
  15. '\" THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
  16. '\" INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
  17. '\" AND FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
  18. '\" ON AN "AS IS" BASIS, AND THE UNIVERSITY OF CALIFORNIA HAS NO OBLIGATION TO
  19. '\" PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
  20. '\" 
  21. '\" $Header: /user6/ouster/wish/man/RCS/wm.n,v 1.18 93/09/20 15:22:57 ouster Exp $ SPRITE (Berkeley)
  22. '/" 
  23. .\" The definitions below are for supplemental macros used in Tcl/Tk
  24. .\" manual entries.
  25. .\"
  26. .\" .HS name section [date [version]]
  27. .\"    Replacement for .TH in other man pages.  See below for valid
  28. .\"    section names.
  29. .\"
  30. .\" .AP type name in/out [indent]
  31. .\"    Start paragraph describing an argument to a library procedure.
  32. .\"    type is type of argument (int, etc.), in/out is either "in", "out",
  33. .\"    or "in/out" to describe whether procedure reads or modifies arg,
  34. .\"    and indent is equivalent to second arg of .IP (shouldn't ever be
  35. .\"    needed;  use .AS below instead)
  36. .\"
  37. .\" .AS [type [name]]
  38. .\"    Give maximum sizes of arguments for setting tab stops.  Type and
  39. .\"    name are examples of largest possible arguments that will be passed
  40. .\"    to .AP later.  If args are omitted, default tab stops are used.
  41. .\"
  42. .\" .BS
  43. .\"    Start box enclosure.  From here until next .BE, everything will be
  44. .\"    enclosed in one large box.
  45. .\"
  46. .\" .BE
  47. .\"    End of box enclosure.
  48. .\"
  49. .\" .VS
  50. .\"    Begin vertical sidebar, for use in marking newly-changed parts
  51. .\"    of man pages.
  52. .\"
  53. .\" .VE
  54. .\"    End of vertical sidebar.
  55. .\"
  56. .\" .DS
  57. .\"    Begin an indented unfilled display.
  58. .\"
  59. .\" .DE
  60. .\"    End of indented unfilled display.
  61. .\"
  62. '\"    # Heading for Tcl/Tk man pages
  63. .de HS
  64. .ds ^3 \\0
  65. .if !"\\$3"" .ds ^3 \\$3
  66. .if '\\$2'cmds'       .TH \\$1 1 \\*(^3 \\$4
  67. .if '\\$2'lib'        .TH \\$1 3 \\*(^3 \\$4
  68. .if '\\$2'tcl'        .TH \\$1 n \\*(^3 Tcl "Tcl Built-In Commands"
  69. .if '\\$2'tk'         .TH \\$1 n \\*(^3 Tk "Tk Commands"
  70. .if '\\$2'tclc'        .TH \\$1 3 \\*(^3 Tcl "Tcl Library Procedures"
  71. .if '\\$2'tkc'         .TH \\$1 3 \\*(^3 Tk "Tk Library Procedures"
  72. .if '\\$2'tclcmds'         .TH \\$1 1 \\*(^3 Tk "Tcl Applications"
  73. .if '\\$2'tkcmds'         .TH \\$1 1 \\*(^3 Tk "Tk Applications"
  74. .if t .wh -1.3i ^B
  75. .nr ^l \\n(.l
  76. .ad b
  77. ..
  78. '\"    # Start an argument description
  79. .de AP
  80. .ie !"\\$4"" .TP \\$4
  81. .el \{\
  82. .   ie !"\\$2"" .TP \\n()Cu
  83. .   el          .TP 15
  84. .\}
  85. .ie !"\\$3"" \{\
  86. .ta \\n()Au \\n()Bu
  87. \&\\$1    \\fI\\$2\\fP    (\\$3)
  88. .\".b
  89. .\}
  90. .el \{\
  91. .br
  92. .ie !"\\$2"" \{\
  93. \&\\$1    \\fI\\$2\\fP
  94. .\}
  95. .el \{\
  96. \&\\fI\\$1\\fP
  97. .\}
  98. .\}
  99. ..
  100. '\"    # define tabbing values for .AP
  101. .de AS
  102. .nr )A 10n
  103. .if !"\\$1"" .nr )A \\w'\\$1'u+3n
  104. .nr )B \\n()Au+15n
  105. .\"
  106. .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
  107. .nr )C \\n()Bu+\\w'(in/out)'u+2n
  108. ..
  109. '\"    # BS - start boxed text
  110. '\"    # ^y = starting y location
  111. '\"    # ^b = 1
  112. .de BS
  113. .br
  114. .mk ^y
  115. .nr ^b 1u
  116. .if n .nf
  117. .if n .ti 0
  118. .if n \l'\\n(.lu\(ul'
  119. .if n .fi
  120. ..
  121. '\"    # BE - end boxed text (draw box now)
  122. .de BE
  123. .nf
  124. .ti 0
  125. .mk ^t
  126. .ie n \l'\\n(^lu\(ul'
  127. .el \{\
  128. .\"    Draw four-sided box normally, but don't draw top of
  129. .\"    box if the box started on an earlier page.
  130. .ie !\\n(^b-1 \{\
  131. \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
  132. .\}
  133. .el \}\
  134. \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
  135. .\}
  136. .\}
  137. .fi
  138. .br
  139. .nr ^b 0
  140. ..
  141. '\"    # VS - start vertical sidebar
  142. '\"    # ^Y = starting y location
  143. '\"    # ^v = 1 (for troff;  for nroff this doesn't matter)
  144. .de VS
  145. .mk ^Y
  146. .ie n 'mc \s12\(br\s0
  147. .el .nr ^v 1u
  148. ..
  149. '\"    # VE - end of vertical sidebar
  150. .de VE
  151. .ie n 'mc
  152. .el \{\
  153. .ev 2
  154. .nf
  155. .ti 0
  156. .mk ^t
  157. \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
  158. .sp -1
  159. .fi
  160. .ev
  161. .\}
  162. .nr ^v 0
  163. ..
  164. '\"    # Special macro to handle page bottom:  finish off current
  165. '\"    # box/sidebar if in box/sidebar mode, then invoked standard
  166. '\"    # page bottom macro.
  167. .de ^B
  168. .ev 2
  169. 'ti 0
  170. 'nf
  171. .mk ^t
  172. .if \\n(^b \{\
  173. .\"    Draw three-sided box if this is the box's first page,
  174. .\"    draw two sides but no top otherwise.
  175. .ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
  176. .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
  177. .\}
  178. .if \\n(^v \{\
  179. .nr ^x \\n(^tu+1v-\\n(^Yu
  180. \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
  181. .\}
  182. .bp
  183. 'fi
  184. .ev
  185. .if \\n(^b \{\
  186. .mk ^y
  187. .nr ^b 2
  188. .\}
  189. .if \\n(^v \{\
  190. .mk ^Y
  191. .\}
  192. ..
  193. '\"    # DS - begin display
  194. .de DS
  195. .RS
  196. .nf
  197. .sp
  198. ..
  199. '\"    # DE - end display
  200. .de DE
  201. .fi
  202. .RE
  203. .sp .5
  204. ..
  205. .HS wm tk
  206. .BS
  207. '\" Note:  do not modify the .SH NAME line immediately below!
  208. .SH NAME
  209. wm \- Communicate with window manager
  210. .SH SYNOPSIS
  211. \fBwm\fR \fIoption window \fR?\fIargs\fR?
  212. .BE
  213.  
  214. .SH DESCRIPTION
  215. .PP
  216. The \fBwm\fR command is used to interact with window managers in
  217. order to control such things as the title for a window, its geometry,
  218. or the increments in terms of which it may be resized.  The \fBwm\fR
  219. command can take any of a number of different forms, depending on
  220. the \fIoption\fR argument.  All of the forms expect at least one
  221. additional argument, \fIwindow\fR, which must be the path name of a
  222. top-level window.
  223. .PP
  224. The legal forms for the \fBwm\fR command are:
  225. .TP
  226. \fBwm aspect \fIwindow\fR ?\fIminNumer minDenom maxNumer maxDenom\fR?
  227. If \fIminNumer\fR, \fIminDenom\fR, \fImaxNumer\fR, and \fImaxDenom\fR
  228. are all specified, then they will be passed to the window manager
  229. and the window manager should use them to enforce a range of
  230. acceptable aspect ratios for \fIwindow\fR.  The aspect ratio of
  231. \fIwindow\fR (width/length) will be constrained to lie
  232. between \fIminNumer\fR/\fIminDenom\fR and \fImaxNumer\fR/\fImaxDenom\fR.
  233. If \fIminNumer\fR etc. are all specified as empty strings, then
  234. any existing aspect ratio restrictions are removed.
  235. If \fIminNumer\fR etc. are specified, then the command returns an
  236. empty string.  Otherwise, it returns
  237. a Tcl list containing four elements, which are the current values
  238. of \fIminNumer\fR, \fIminDenom\fR, \fImaxNumer\fR, and \fImaxDenom\fR
  239. (if no aspect restrictions are in effect, then an empty string is
  240. returned).
  241. .TP
  242. \fBwm client \fIwindow\fR ?\fIname\fR?
  243. .VS
  244. If \fIname\fR is specified, this command stores \fIname\fR (which
  245. should be the name of
  246. the host on which the application is executing) in \fIwindow\fR's
  247. \fBWM_CLIENT_MACHINE\fR property for use by the window manager or
  248. session manager.
  249. The command returns an empty string in this case.
  250. If \fIname\fR isn't specified, the command returns the last name
  251. set in a \fBwm client\fR command for \fIwindow\fR.
  252. If \fIname\fR is specified as an empty string, the command deletes the
  253. \fBWM_CLIENT_MACHINE\fR property from \fIwindow\fR.
  254. .TP
  255. \fBwm command \fIwindow\fR ?\fIvalue\fR?
  256. If \fIvalue\fR is specified, this command stores \fIvalue\fR in \fIwindow\fR's
  257. \fBWM_COMMAND\fR property for use by the window manager or
  258. session manager and returns an empty string.
  259. \fIValue\fR must have proper list structure;  the elements should
  260. contain the words of the command used to invoke the application.
  261. If \fIvalue\fR isn't specified then the command returns the last value
  262. set in a \fBwm command\fR command for \fIwindow\fR.
  263. If \fIvalue\fR is specified as an empty string, the command
  264. deletes the \fBWM_COMMAND\fR property from \fIwindow\fR.
  265. .VE
  266. .TP
  267. \fBwm deiconify \fIwindow\fR
  268. Arrange for \fIwindow\fR to be displayed in normal (non-iconified) form.
  269. This is done by mapping the window.  If the window has never been
  270. mapped then this command will not map the window, but it will ensure
  271. that when the window is first mapped it will be displayed
  272. in de-iconified form.  Returns an empty string.
  273. .TP
  274. \fBwm focusmodel \fIwindow\fR ?\fBactive\fR|\fBpassive\fR?
  275. If \fBactive\fR or \fBpassive\fR is supplied as an optional argument
  276. to the command, then it specifies the focus model for \fIwindow\fR.
  277. In this case the command returns an empty string.  If no additional
  278. argument is supplied, then the command returns the current focus
  279. model for \fIwindow\fR.
  280. An \fBactive\fR focus model means that \fIwindow\fR will claim the
  281. input focus for itself or its descendants, even at times when
  282. the focus is currently in some other application.  \fBPassive\fR means that
  283. \fIwindow\fR will never claim the focus for itself:  the window manager
  284. should give the focus to \fIwindow\fR at appropriate times.  However,
  285. once the focus has been given to \fIwindow\fR or one of its descendants,
  286. the application may re-assign the focus among \fIwindow\fR's descendants.
  287. The focus model defaults to \fBpassive\fR, and Tk's \fBfocus\fR command
  288. assumes a passive model of focussing.
  289. .TP
  290. \fBwm frame \fIwindow\fR
  291. .VS
  292. If \fIwindow\fR has been reparented by the window manager into a
  293. decorative frame, the command returns the X window identifier for
  294. the outermost frame that contains \fIwindow\fR (the window whose
  295. parent is the root or virtual root).  If \fIwindow\fR hasn't been
  296. reparented by the window manager then the command returns the
  297. X window identifier for \fIwindow\fR.
  298. .VE
  299. .TP
  300. \fBwm geometry \fIwindow\fR ?\fInewGeometry\fR?
  301. If \fInewGeometry\fR is specified, then the geometry of \fIwindow\fR
  302. is changed and an empty string is returned.  Otherwise the current
  303. geometry for \fIwindow\fR is returned (this is the most recent
  304. geometry specified either by manual resizing or
  305. in a \fBwm geometry\fR command).  \fINewGeometry\fR has
  306. the form \fB=\fIwidth\fBx\fIheight\fB\(+-\fIx\fB\(+-\fIy\fR, where
  307. any of \fB=\fR, \fIwidth\fBx\fIheight\fR, or \fB\(+-\fIx\fB\(+-\fIy\fR
  308. may be omitted.  \fIWidth\fR and \fIheight\fR are positive integers
  309. specifying the desired dimensions of \fIwindow\fR.  If \fIwindow\fR
  310. is gridded (see GRIDDED GEOMETRY MANAGEMENT below) then the dimensions
  311. are specified in grid units;  otherwise they are specified in pixel
  312. units.  \fIX\fR and \fIy\fR specify the desired location of
  313. \fIwindow\fR on the screen, in pixels.
  314. If \fIx\fR is preceded by \fB+\fR, it specifies
  315. the number of pixels between the left edge of the screen and the left
  316. edge of \fIwindow\fR's border;  if preceded by \fB\-\fR then
  317. \fIx\fR specifies the number of pixels
  318. between the right edge of the screen and the right edge of \fIwindow\fR's
  319. border.  If \fIy\fR is preceded by \fB+\fR then it specifies the
  320. number of pixels between the top of the screen and the top
  321. of \fIwindow\fR's border;  if \fIy\fR is preceded by \fB\-\fR then
  322. it specifies the number of pixels between the bottom of \fIwindow\fR's
  323. border and the bottom of the screen.
  324. If \fInewGeometry\fR is specified as an empty string then any
  325. existing user-specified geometry for \fIwindow\fR is cancelled, and
  326. the window will revert to the size requested internally by its
  327. widgets.
  328. .TP
  329. \fBwm grid \fIwindow\fR ?\fIbaseWidth baseHeight widthInc heightInc\fR?
  330. This command indicates that \fIwindow\fR is to be managed as a
  331. gridded window.
  332. It also specifies the relationship between grid units and pixel units.
  333. \fIBaseWidth\fR and \fIbaseHeight\fR specify the number of grid
  334. units corresponding to the pixel dimensions requested internally
  335. by \fIwindow\fR using \fBTk_GeometryRequest\fR.  \fIWidthInc\fR
  336. and \fIheightInc\fR specify the number of pixels in each horizontal
  337. and vertical grid unit.
  338. These four values determine a range of acceptable sizes for
  339. \fIwindow\fR, corresponding to grid-based widths and heights
  340. that are non-negative integers.
  341. Tk will pass this information to the window manager;  during
  342. manual resizing, the window manager will restrict the window's size
  343. to one of these acceptable sizes.
  344. Furthermore, during manual resizing the window manager will display
  345. the window's current size in terms of grid units rather than pixels.
  346. If \fIbaseWidth\fR etc. are all specified as empty strings, then
  347. \fIwindow\fR will no longer be managed as a gridded window.  If
  348. \fIbaseWidth\fR etc. are specified then the return value is an
  349. empty string.
  350. Otherwise the return value is a Tcl list containing
  351. four elements corresponding to the current \fIbaseWidth\fR,
  352. \fIbaseHeight\fR, \fIwidthInc\fR, and \fIheightInc\fR;  if
  353. \fIwindow\fR is not currently gridded, then an empty string
  354. is returned.
  355. Note: this command should not be needed very often, since the
  356. \fBTk_SetGrid\fR library procedure and the \fBsetGrid\fR option
  357. provide easier access to the same functionality.
  358. .TP
  359. \fBwm group \fIwindow\fR ?\fIpathName\fR?
  360. If \fIpathName\fR is specified, it gives the path name for the leader of
  361. a group of related windows.  The window manager may use this information,
  362. for example, to unmap all of the windows in a group when the group's
  363. leader is iconified.  \fIPathName\fR may be specified as an empty string to
  364. remove \fIwindow\fR from any group association.  If \fIpathName\fR is
  365. specified then the command returns an empty string;  otherwise it
  366. returns the path name of \fIwindow\fR's current group leader, or an empty
  367. string if \fIwindow\fR isn't part of any group.
  368. .TP
  369. \fBwm iconbitmap \fIwindow\fR ?\fIbitmap\fR?
  370. If \fIbitmap\fR is specified, then it names a bitmap in the standard
  371. forms accepted by Tk (see the \fBTk_GetBitmap\fR manual entry for details).
  372. This bitmap is passed to the window manager to be displayed in
  373. \fIwindow\fR's icon, and the command returns an empty string.  If
  374. an empty string is specified for \fIbitmap\fR, then any current icon
  375. bitmap is cancelled for \fIwindow\fR.
  376. If \fIbitmap\fR is specified then the command returns an empty string.
  377. Otherwise it returns the name of
  378. the current icon bitmap associated with \fIwindow\fR, or an empty
  379. string if \fIwindow\fR has no icon bitmap.
  380. .TP
  381. \fBwm iconify \fIwindow\fR
  382. Arrange for \fIwindow\fR to be iconified.  It \fIwindow\fR hasn't
  383. yet been mapped for the first time, this command will arrange for
  384. it to appear in the iconified state when it is eventually mapped.
  385. .TP
  386. \fBwm iconmask \fIwindow\fR ?\fIbitmap\fR?
  387. If \fIbitmap\fR is specified, then it names a bitmap in the standard
  388. forms accepted by Tk (see the \fBTk_GetBitmap\fR manual entry for details).
  389. This bitmap is passed to the window manager to be used as a mask
  390. in conjunction with the \fBiconbitmap\fR option:  where the mask
  391. has zeroes no icon will be displayed;  where it has ones, the bits
  392. from the icon bitmap will be displayed.  If
  393. an empty string is specified for \fIbitmap\fR then any current icon
  394. mask is cancelled for \fIwindow\fR (this is equivalent to specifying
  395. a bitmap of all ones).  If \fIbitmap\fR is specified
  396. then the command returns an empty string.  Otherwise it
  397. returns the name of the current icon mask associated with
  398. \fIwindow\fR, or an empty string if no mask is in effect.
  399. .TP
  400. \fBwm iconname \fIwindow\fR ?\fInewName\fR?
  401. If \fInewName\fR is specified, then it is passed to the window
  402. manager;  the window manager should display \fInewName\fR inside
  403. the icon associated with \fIwindow\fR.  In this case an empty
  404. string is returned as result.  If \fInewName\fR isn't specified
  405. then the command returns the current icon name for \fIwindow\fR,
  406. or an empty string if no icon name has been specified (in this
  407. case the window manager will normally display the window's title,
  408. as specified with the \fBwm title\fR command).
  409. .TP
  410. \fBwm iconposition \fIwindow\fR ?\fIx y\fR?
  411. If \fIx\fR and \fIy\fR are specified, they are passed to the window
  412. manager as a hint about where to position the icon for \fIwindow\fR.
  413. In this case an empty string is returned.  If \fIx\fR and \fIy\fR are
  414. specified as empty strings then any existing icon position hint is cancelled.
  415. If neither \fIx\fR nor \fIy\fR is specified, then the command returns
  416. a Tcl list containing two values, which are the current icon position
  417. hints (if no hints are in effect then an empty string is returned).
  418. .TP
  419. \fBwm iconwindow \fIwindow\fR ?\fIpathName\fR?
  420. If \fIpathName\fR is specified, it is the path name for a window to
  421. use as icon for \fIwindow\fR: when \fIwindow\fR is iconified then
  422. \fIpathName\fR should be mapped to serve as icon, and when \fIwindow\fR
  423. is de-iconified then \fIpathName\fR will be unmapped again.  If
  424. \fIpathName\fR is specified as an empty string then any existing
  425. icon window association for \fIwindow\fR will be cancelled.  If
  426. the \fIpathName\fR argument is specified then an empty string is
  427. returned.  Otherwise the command returns the path name of the
  428. current icon window for \fIwindow\fR, or an empty string if there
  429. is no icon window currently specified for \fIwindow\fR.  Note:
  430. not all window managers support the notion of an icon window.
  431. .TP
  432. \fBwm maxsize \fIwindow\fR ?\fIwidth height\fR?
  433. If \fIwidth\fR and \fIheight\fR are specified, then \fIwindow\fR
  434. becomes resizable and \fIwidth\fR and \fIheight\fR give its
  435. maximum permissible dimensions.
  436. For gridded windows the dimensions are specified in
  437. grid units;  otherwise they are specified in pixel units.
  438. During manual sizing, the window manager
  439. should restrict the window's dimensions to be less than or
  440. equal to \fIwidth\fR and \fIheight\fR.
  441. If \fIwidth\fR and \fIheight\fR are specified as empty strings,
  442. then the maximum size option is cancelled for \fIwindow\fR.
  443. If \fIwidth\fR and \fIheight\fR are
  444. specified, then the command returns an empty string.  Otherwise
  445. it returns a Tcl list with two elements, which are the
  446. maximum width and height currently in effect;  if no maximum
  447. dimensions are in effect for \fIwindow\fR then an empty
  448. string is returned.  See the sections on geometry management
  449. below for more information.
  450. .TP
  451. \fBwm minsize \fIwindow\fR ?\fIwidth height\fR?
  452. If \fIwidth\fR and \fIheight\fR are specified, then \fIwindow\fR
  453. becomes resizable and \fIwidth\fR and \fIheight\fR give its
  454. minimum permissible dimensions.
  455. For gridded windows the dimensions are specified in
  456. grid units;  otherwise they are specified in pixel units.
  457. During manual sizing, the window manager
  458. should restrict the window's dimensions to be greater than or
  459. equal to \fIwidth\fR and \fIheight\fR.
  460. If \fIwidth\fR and \fIheight\fR are specified as empty strings,
  461. then the minimum size option is cancelled for \fIwindow\fR.
  462. If \fIwidth\fR and \fIheight\fR are
  463. specified, then the command returns an empty string.  Otherwise
  464. it returns a Tcl list with two elements, which are the
  465. minimum width and height currently in effect;  if no minimum
  466. dimensions are in effect for \fIwindow\fR then an empty
  467. string is returned.  See the sections on geometry management
  468. below for more information.
  469. .TP
  470. \fBwm overrideredirect \fIwindow\fR ?\fIboolean\fR?
  471. .VS
  472. If \fIboolean\fR is specified, it must have a proper boolean form and
  473. the override-redirect flag for \fIwindow\fR is set to that value.
  474. If \fIboolean\fR is not specified then \fB1\fR or \fB0\fR is
  475. returned to indicate whether or not the override-redirect flag
  476. is currently set for \fIwindow\fR.
  477. Setting the override-redirect flag for a window causes
  478. it to be ignored by the window manager;  among other things, this means
  479. that the window will not be reparented from the root window into a
  480. decorative frame and the user will not be able to manipulate the
  481. window using the normal window manager mechanisms.
  482. .VE
  483. .TP
  484. \fBwm positionfrom \fIwindow\fR ?\fIwho\fR?
  485. If \fIwho\fR is specified, it must be either \fBprogram\fR or
  486. \fBuser\fR, or an abbreviation of one of these two.  It indicates
  487. whether \fIwindow\fR's current position was requested by the
  488. program or by the user.  Many window managers ignore program-requested
  489. initial positions and ask the user to manually position the window;  if
  490. \fBuser\fR is specified then the window manager should position the
  491. window at the given place without asking the user for assistance.
  492. If \fIwho\fR is specified as an empty string, then the current position
  493. source is cancelled.
  494. If \fIwho\fR is specified, then the command returns an empty string.
  495. Otherwise it returns \fBuser\fR or \fBwindow\fR to indicate the
  496. source of the window's current position, or an empty string if
  497. no source has been specified yet.  Most window managers interpret
  498. ``no source'' as equivalent to \fBprogram\fR.
  499. .VS
  500. Tk will automatically set the position source to \fBuser\fR
  501. when a \fBwm geometry\fR command is invoked, unless the source has
  502. been set explicitly to \fBprogram\fR.
  503. .TP
  504. \fBwm protocol \fIwindow\fR ?\fIname\fR? ?\fIcommand\fR?
  505. This command is used to manage window manager protocols such as
  506. \fBWM_DELETE_WINDOW\fR.
  507. \fIName\fR is the name of an atom corresponding to a window manager
  508. protocol, such as \fBWM_DELETE_WINDOW\fR or \fBWM_SAVE_YOURSELF\fR
  509. or \fBWM_TAKE_FOCUS\fR.
  510. If both \fIname\fR and \fIcommand\fR are specified, then \fIcommand\fR
  511. is associated with the protocol specified by \fIname\fR.
  512. \fIName\fR will be added to \fIwindow\fR's \fBWM_PROTOCOLS\fR
  513. property to tell the window manager that the application has a
  514. protocol handler for \fIname\fR, and \fIcommand\fR will
  515. be invoked in the future whenever the window manager sends a
  516. message to the client for that protocol.
  517. In this case the command returns an empty string.
  518. If \fIname\fR is specified but \fIcommand\fR isn't, then the current
  519. command for \fIname\fR is returned, or an empty string if there
  520. is no handler defined for \fIname\fR.
  521. If \fIcommand\fR is specified as an empty string then the current
  522. handler for \fIname\fR is deleted and it is removed from the
  523. \fBWM_PROTOCOLS\fR property on \fIwindow\fR;  an empty string is
  524. returned.
  525. Lastly, if neither \fIname\fR nor \fIcommand\fR is specified, the
  526. command returns a list of all the protocols for which handlers
  527. are currently defined for \fIwindow\fR.
  528. .RS
  529. .LP
  530. Tk always defines a protocol handler for \fBWM_DELETE_WINDOW\fR, even if
  531. you haven't asked for one with \fBwm protocol\fR.
  532. If a \fBWM_DELETE_WINDOW\fR message arrives when you haven't defined
  533. a handler, then Tk handles the message by destroying the window for
  534. which it was received.
  535. .RE
  536. .VE
  537. .TP
  538. \fBwm sizefrom \fIwindow\fR ?\fIwho\fR?
  539. If \fIwho\fR is specified, it must be either \fBprogram\fR or
  540. \fBuser\fR, or an abbreviation of one of these two.  It indicates
  541. whether \fIwindow\fR's current size was requested by the
  542. program or by the user.  Some window managers ignore program-requested
  543. sizes and ask the user to manually size the window;  if
  544. \fBuser\fR is specified then the window manager should give the
  545. window its specified size without asking the user for assistance.
  546. If \fIwho\fR is specified as an empty string, then the current size
  547. source is cancelled.
  548. If \fIwho\fR is specified, then the command returns an empty string.
  549. Otherwise it returns \fBuser\fR or \fBwindow\fR to indicate the
  550. source of the window's current size, or an empty string if
  551. no source has been specified yet.  Most window managers interpret
  552. ``no source'' as equivalent to \fBprogram\fR.
  553. .TP
  554. \fBwm state \fIwindow\fR
  555. .VS
  556. Returns the current state of \fIwindow\fR:  either \fBnormal\fR,
  557. \fBiconic\fR, or \fBwithdrawn\fR.
  558. .VE
  559. .TP
  560. \fBwm title \fIwindow\fR ?\fIstring\fR?
  561. If \fIstring\fR is specified, then it will be passed to the window
  562. manager for use as the title for \fIwindow\fR (the window manager
  563. should display this string in \fIwindow\fR's title bar).  In this
  564. case the command returns an empty string.  If \fIstring\fR isn't
  565. specified then the command returns the current title for the
  566. \fIwindow\fR.  The title for a window defaults to its name.
  567. .TP
  568. \fBwm transient \fIwindow\fR ?\fImaster\fR?
  569. If \fImaster\fR is specified, then the window manager is informed
  570. that \fIwindow\fR is a transient window (e.g. pull-down menu) working
  571. on behalf of \fImaster\fR (where \fImaster\fR is the
  572. path name for a top-level window).  Some window managers will use
  573. this information to manage \fIwindow\fR specially.  If \fImaster\fR
  574. is specified as an empty string then \fIwindow\fR is marked as not
  575. being a transient window any more.  If \fImaster\fR is specified,
  576. then the command returns an empty string.  Otherwise the command
  577. returns the path name of \fIwindow\fR's current master, or an
  578. empty string if \fIwindow\fR isn't currently a transient window.
  579. .TP
  580. \fBwm withdraw \fIwindow\fR
  581. Arranges for \fIwindow\fR to be withdrawn from the screen.  This
  582. causes the window to be unmapped and forgotten about by the window
  583. manager.  If the window
  584. .VS
  585. has never been mapped, then this command
  586. causes the window to be mapped in the withdrawn state.  Not all
  587. window managers appear to know how to handle windows that are
  588. mapped in the withdrawn state.
  589. .VE
  590. Note: it sometimes seems to be necessary to withdraw a
  591. window and then re-map it (e.g. with \fBwm deiconify\fR) to get some
  592. window managers to pay attention to changes in window attributes
  593. such as group.
  594.  
  595. .SH "SOURCES OF GEOMETRY INFORMATION"
  596. .PP
  597. Size-related information for top-level windows
  598. can come from three sources.
  599. First, geometry requests come from the widgets that are descendants
  600. of a top-level window.
  601. Each widget requests a particular size for itself
  602. by calling \fBTk_GeometryRequest\fR.  This information is passed to
  603. geometry managers, which then request large enough sizes for parent
  604. windows so that they can layout the children properly.
  605. Geometry information passes upwards through the window hierarchy
  606. until eventually a particular size is requested for each top-level
  607. window.
  608. These requests are called \fIinternal requests\fR in the discussion
  609. below.
  610. The second source of width and height information is through the
  611. \fBwm geometry\fR command.  Third, the user can
  612. request a particular size for a window using the
  613. interactive facilities of the window manager.
  614. The second and third types of geometry requests are called
  615. \fIexternal requests\fR in the discussion below;  Tk treats
  616. these two kinds of requests identically.
  617.  
  618. .SH "UNGRIDDED GEOMETRY MANAGEMENT"
  619. .PP
  620. Tk allows the geometry of a top-level window to be managed in
  621. either of two general ways: ungridded or gridded.
  622. The ungridded form occurs if no \fBwm grid\fR command
  623. has been issued for a top-level window.
  624. Ungridded management has several variants.
  625. In the simplest variant of ungridded windows,
  626. no \fBwm geometry\fR, \fBwm minsize\fR, or \fBwm maxsize\fR
  627. commands have been invoked either.
  628. In this case, the window's size is
  629. determined totally by the internal requests emanating from the
  630. widgets inside the window:  Tk will ask the window manager not to
  631. permit the user to resize the window interactively.
  632. .PP
  633. If a \fBwm geometry\fR command is invoked on an ungridded window,
  634. then the size in that command overrides any size requested by the
  635. window's widgets;  from now on, the window's size will be determined
  636. entirely by the most recent information from \fBwm geometry\fR
  637. commands.  To go back to using the size requested by the window's
  638. widgets, issue a \fBwm geometry\fR command with an empty \fIgeometry\fR
  639. string.
  640. .PP
  641. To enable interactive resizing of an ungridded window, one or both
  642. of the \fBwm maxsize\fR
  643. and \fBwm minsize\fR commands must be issued.
  644. The information from these commands will be passed to the window
  645. manager, and size changes within the specified range will be permitted.
  646. For ungridded windows the limits refer to the top-level window's
  647. dimensions in pixels.
  648. If only a \fBwm maxsize\fR command is issued then the minimum
  649. dimensions default to 1;  if only a \fBwm minsize\fR command is
  650. .VS
  651. issued then the maximum dimensions default to the size of the display.
  652. .VE
  653. If the size of a window is changed interactively, it has the same
  654. effect as if \fBwm geometry\fR had been invoked:  from now on, internal
  655. geometry requests will be ignored.
  656. To return to internal control over the window's size, issue a
  657. \fBwm geometry\fR command with an empty \fIgeometry\fR argument.
  658. If a window has been manually resized or moved, the \fBwm geometry\fR
  659. command will return the geometry that was requested interactively.
  660.  
  661. .SH "GRIDDED GEOMETRY MANAGEMENT"
  662. .PP
  663. The second style of geometry management is called \fIgridded\fR.
  664. This approach occurs when one of the widgets of an application
  665. supports a range of useful sizes.
  666. This occurs, for example, in a text editor where the scrollbars,
  667. menus, and other adornments are fixed in size but the edit widget
  668. can support any number of lines of text or characters per line.
  669. In this case, it is usually desirable to let the user specify the
  670. number of lines or characters-per-line, either with the
  671. \fBwm geometry\fR command or by interactively resizing the window.
  672. In the case of text, and in other interesting cases also, only
  673. discrete sizes of the window make sense, such as integral numbers
  674. of lines and characters-per-line;  arbitrary pixel sizes are not useful.
  675. .PP
  676. Gridded geometry management provides support for this kind of
  677. application.
  678. Tk (and the window manager) assume that there is a grid of some
  679. sort within the application and that the application should be
  680. resized in terms of \fIgrid units\fR rather than pixels.
  681. Gridded geometry management is typically invoked by turning on
  682. the \fBsetGrid\fR option for a widget;  it can also be invoked
  683. with the \fBwm grid\fR command or by calling \fBTk_SetGrid\fR.
  684. In each of these approaches the particular widget (or sometimes
  685. code in the application as a whole) specifies the relationship between 
  686. integral grid sizes for the window and pixel sizes.
  687. To return to non-gridded geometry management, invoke
  688. \fBwm grid\fR with empty argument strings.
  689. .PP
  690. When gridded geometry management is enabled then all the dimensions specified
  691. in \fBwm minsize\fR, \fBwm maxsize\fR, and \fBwm geometry\fR commands
  692. are treated as grid units rather than pixel units.
  693. Interactive resizing is automatically enabled, and it will be
  694. carried out in even numbers of grid units rather than pixels.
  695. By default there are no limits on the minimum or maximum dimensions
  696. of a gridded window.
  697. As with ungridded windows, interactive resizing has exactly the
  698. same effect as invoking the \fBwm geometry\fR command.
  699. For gridded windows, internally- and externally-requested dimensions
  700. work together: the externally-specified width and height determine
  701. the size of the window in grid units, and the information from the
  702. last \fBwm grid\fR command maps from grid units to pixel units.
  703.  
  704. .SH BUGS
  705. .PP
  706. The window manager interactions seem too complicated, especially
  707. for managing geometry.  Suggestions on how to simplify this would
  708. be greatly appreciated.
  709. .PP
  710. Most existing window managers appear to have bugs that affect the
  711. operation of the \fBwm\fR command.  For example, some changes won't
  712. take effect if the window is already active:  the window will have
  713. to be withdrawn and de-iconified in order to make the change happen.
  714.  
  715. .SH KEYWORDS
  716. aspect ratio, deiconify, focus model, geometry, grid, group, icon, iconify, increments, position, size, title, top-level window, units, window manager
  717.